Document recommended way for running tests
authorCarol (Nichols || Goulding) <carol.nichols@gmail.com>
Tue, 13 Sep 2016 01:45:29 +0000 (21:45 -0400)
committerCarol (Nichols || Goulding) <carol.nichols@gmail.com>
Tue, 13 Sep 2016 01:45:29 +0000 (21:45 -0400)
Fixes #3084.

README.md

index 49d73629aae022ff0fa5d5beba731df45f5007f4..71c74508d7908e687b7d0d182165d71c5a710bf3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -76,6 +76,12 @@ bit versions of cargo on unix you would use:
 $ ./configure --target=i686-unknown-linux-gnu,x86_64-unknown-linux-gnu
 ```
 
+## Running the tests
+
+To run cargo's tests, use `cargo test`. If you do not have the cross-compilers
+installed locally, ignore the cross-compile test failures, or disable them by
+using `CFG_DISABLE_CROSS_TESTS=1 cargo test`.
+
 ## Adding new subcommands to Cargo
 
 Cargo is designed to be extensible with new subcommands without having to modify